[Doc] Fixed typos and improved cross-referencing in ppo tutorial #2490
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/2490
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit b0b7123: This comment was automatically generated by Dr. CI and updates every 15 minutes. |
✅ Deploy Preview for pytorch-tutorials-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
vmoens
approved these changes
Jun 26, 2023
svekars
approved these changes
Jun 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2489
Description
In this pull request, I've made some changes to improve the clarity and ease of navigation within our documentation. Specifically, I've enhanced cross-referencing by updating the way certain class references are displayed. I replaced the previous format of ":class:
SomeClass" with a more succinct and user-friendly format :class:~path.to.SomeClass. This new format hides the full path of the class and only displays the class name, while still linking to the correct location.Additionally, I took the liberty of correcting some typographical errors scattered throughout the documentation, further improving readability.
Checklist
cc @svekars @carljparker @vmoens @nairbv